home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / win_nt95 / tinxnt11.zip / TINTIN.DOC < prev    next >
Text File  |  1995-08-01  |  14KB  |  324 lines

  1.                                 T I N T I N
  2.                                    I I I
  3.                  (T)he K(I)cki(N) (T)ick D(I)kumud Clie(N)t
  4.  
  5. This is version 3.0 of TINTIN. Lotsa stuff has been changed since the last
  6. release. New features have been added. But TINTIN is still a small, fast
  7. client special designed to help dikumud-players in their slaughtering.
  8.  
  9. ======================================Me==================================
  10. You can email me at: pjunold@daimi.aau.dk
  11. Feel free to mail if you discover any bugs, have any probs with the prog or 
  12. have suggestions for any new(and useful) tintin-commands then lemmie hear.
  13.  
  14. ===============================Compiling TINTIN===========================
  15. Before compiling you might wanna change some of the default values for your
  16. tintin setup. Look at the top of the file called 'tintin.h' for more info.
  17.  
  18. I assume you have placed all the files in a directory. Then you type
  19. 'make'. After a moment there'll be a new file in the directory - 'tintin'.
  20. OK if you the program compiled without any problems, then go to next section
  21. and read on.
  22.  
  23. Oh no! TINTIN didn't compile at first try. No worry - there's lots of 
  24. informations in the makefile. Editing this file should get you going.
  25. If you know nothing about c- and unix-programming, then ask someone at your
  26. site who does. TINTIN III is really not a complicated program, and you 
  27. properly just have to comment or uncomment a few flags in the makefile. 
  28. If no one at your site can help, then feel free to gimmie a mail.
  29.  
  30. ========================Starting and ending TINTIN========================
  31. The syntax for starting tintin is: tintin [commandfile]
  32. Read more about the commandfile in the 'files' section below. Remember one
  33. thing though. ALL ACTIONS, ALIASES AND SUBSTITUTIONS DEFINED WHEN STARTING
  34. UP TINTIN, ARE INHERITED BY ALL SESSIONS.
  35.  
  36. If you wanna get out of tintin after starting it type: #end
  37.  
  38. =================================Basic features===========================
  39. I'll start by explaining some of the very basic and important features:
  40.  
  41. All TINTIN commands starts with a '#'. (can be changed with #char though)
  42. Example:
  43. #help         <=#help is a command directed to the client and not the mud.
  44.  
  45. All TINTIN commands can be abrevated when typed.
  46. Example:
  47. #he           <=typing #he is the same as typing #help
  48.  
  49. All commands can be seperated with a ';'.
  50. Example:
  51. n;l green;s;say Dan Dare is back!    <=do these 4 commands
  52.  
  53. There are 2 ways the command-split-at-';'s can be overruled. 
  54. 1) typing '\;' on a line will be translated to a single ';'
  55. Example:
  56. say Hello \;)      <=say Hello ;)
  57.  
  58. 2) ';'s inside a "<---->" sentence will be parsed as normal ';'s
  59. Example:
  60. say "hello ;) How's going?" <=say hello ;) How's going.
  61.  
  62. The last method is important when for example having an alias to execute
  63. more commands. More on that later.
  64.  
  65. ===================Connecting to a mud - the #session command==============
  66. Command: session [[sessionname] mud-address]
  67. Usage: #session 
  68.  
  69. This is the command you use to connect to the muds. The session that  
  70. you startup will become the active session. That is, all commands you
  71. type, will be send to this session.
  72.  
  73. Here's a small example to get you started: 
  74. It shows how I log into austin diku with 2 chars and play a bit with them.
  75.  
  76. %tintin                                   <=startup tintin
  77. #session snowy austin.daimi.aau.dk 4000   <=define a session named 'snowy',
  78. <<usual login stuff>>                       and connect to austin diku
  79. #session zork austin.daimi.aau.dk 4000    <=define a new session name 'zork'
  80. <<usual login stuff>                        and connect to austin diku
  81.  
  82. When I type commands now, they are send to the char I loged in with.
  83. I can change the active char, by typing #sessionname
  84.  
  85. #snowy                                     <=make the char in the 'snowy'
  86.                                              session the active one.
  87.  
  88. When I type commands now, they are send to the 'snowy' char.
  89.  
  90. If I wanna send a command to a session that isn't active, without having 
  91. the trouble to activate it, I can type #sessionname command
  92. #zork say anybody here wanna die???    <=the 'zork' char will say this
  93. #zork "puke mayor;kill mayor"          <=and do this..
  94.  
  95. If I wanna see the text that a session recives without switching to it, I can
  96. type: #snoop sessionname. Remove the snoop by typing #snoop sessioname again.
  97. #snoop zork                                <=snoop the zork session
  98. #snoop zork                                <=unsnoop zork session
  99.  
  100. If I want all sessions to recieve same command I type: #all command
  101. #all shout dikuMUD at 300mph or DON'T dikuMUD!  
  102.  
  103. You can get a list of all session by typing: #session. The current active 
  104. session is marked with (active). Snooped sessions with (snooped).
  105.  
  106. ====================================Alias==================================
  107. Command: alias
  108. Usage: #alias [aliased-command] [unaliases-command(s)]
  109.  
  110. The syntax of the #alias command is almost like alias in csh.
  111. Use this command to define aliases. The variables &0, &1.. &9 contains
  112. the arguments to the aliases-command as follows:
  113. the &0 variable contains ALL the arguments.
  114. the &1 variable contains the 1. argument
  115. ....
  116. the &9 variable contains the 9. argument
  117.  
  118. Example: #alias nice say Hello Mr &1
  119.  
  120. typing: > nice Ole Bole 
  121. then &0 =Ole Bole
  122.      &1 =Ole
  123.      &2 =Bole
  124. Thus the alias would be evaluated to: say Hullo Mr Ole
  125.  
  126. If there're no variables on the right-side of the alias definition, any
  127. arguments following the aliases-command will be appended to the unaliases-
  128. command. 
  129. Example:
  130. #alias ff cast 'fireball'
  131. >ff mayor
  132. evaluates to: cast 'fireball' mayor
  133.  
  134. If you want an alias to execute more commands, you must use "s:
  135.  
  136. #alias ws "wake;stand"    <=remember the ';'s inside "s don't end the argument.
  137.  
  138. Other examples:
  139. #alias eb "get bread bag;eat bread"       <=define alias
  140. #alias eb                                 <=show alias
  141. #alias                                    <=list all aliases
  142. #alias put pu &1 in &2                    <=for dikuII maybe...
  143.  
  144. To delete an alias use the #unalias command.
  145. #unalias eb                               <=delete the eb alias.
  146.  
  147. WARNING! TINTIN III doesn't check for recursive aliases! That is surpose you type
  148. something like: #alias yo yo
  149. and then do a: yo
  150. then TINTIN goes into an endless loop.. #&*^@$&*^@$*^&@$#&*
  151.  
  152.  ====================================Action================================
  153. Command: action
  154. Usage: #action [action-text] [action-command(s)]
  155.  
  156. Use this command to define an action to take place when a particular text
  157. appears on your screen. There're 10 variables you can use as wildcards in
  158. the action-text. These variables are &0, &1, &2....&9. 
  159.  
  160. Examples: 
  161.  
  162. #action BLEEDING recite recall                    <=recall when you get that 
  163.                                                     nasty BLEEDING text.
  164.  
  165. #action "are hungry" "get bread bag;eat bread"    <=auto-eat
  166.  
  167. #action "&0 has arrived." shake &0                <=shake hands with people
  168.                                                     that arrives.
  169.                    
  170. #action "&0 says '&1'" "say &0 said &1"           <=repeat all says.
  171.  
  172. #action "tells you" #bell                         <=beep when you gets a tell
  173.  
  174. #action                                           <=show actions
  175. #action ws                                        <=show action
  176. #unaction ws                                      <=delete action
  177.  
  178. You can have tintin ignore the actions if you type '#ignore'. Turn the 
  179. ignoring off by typing '#ignore' again.
  180.  
  181. You can see what commands TINTIN executes when an action triggers,
  182. by typing '#echo'. Turn this feature off by typing '#echo' again.
  183.  
  184. ===============================Substitutes================================
  185. Command: #substitute     (remember you can abrevate commands....)
  186. Usage: #substitute [text] [substitute text]
  187.  
  188. This command works a bit like #action. The purpose of this command is to
  189. substitute text from the mud with some text you provide. You can think of 
  190. this command, as a kind of extended gag-command. 
  191.  
  192. Examples:
  193. Suppose you want all the occurences of the word 'Snowy' to be substituted
  194. with 'The King'. Then you'll type: 
  195. #subs &0Snowy&1 &0The King&1
  196.  
  197. Now suppose the mud sends you the line: Snowy har arrived.
  198. Then your substitution would get triggered and the variables would contain:
  199. &0 =nothing (there wasn't anything in front of the word 'Snowy')
  200. &1 = has arrived.
  201. Substituted into the line is then:
  202. The King has arrived.
  203.  
  204. There IS in fact a serious purpose for this command. People using a setup like:
  205. Home<--------SLOW modem------->School<------FAST modem------------>mud site
  206. complain that they keep loosing their link, when the mud sends to much text too
  207. fast(as in fights on grimne-diku for example). The problem is that their own 
  208. modem is too slow for the transfer. People like that can use the #sub command
  209. to reduce the amount of data transfered.
  210.  
  211. Example: (grimne diku)
  212.  
  213. #sub &0POWERMAD&1    &0PM&1
  214. #sub &0Black&1       &0B&1
  215. #sub &0obliterates&1 &0obr&1
  216.  
  217. if the diku sends the line: Black obliterates POWERMAD.
  218. you'd see: B obr PM.
  219. If you didn't want to see anything from the lines with Black you'd do a:
  220. #sub Black .          (i never liked this dot syntax...)
  221. and you''ll never see the lines.
  222.  
  223. Use #unsub to delete substitutions.
  224.  
  225. ================================Speedwalk===================================
  226. If you type a command consisting ONLY of letters n, e, s, w, u, d - then 
  227. this command will be interpreted as a serie of directions you wanna go.
  228. Example: >sswn
  229. go south, south, west, north
  230.  
  231. IF who have problems with typing some commands that actually ONLY consists
  232. of these words, then type'em in CAPS.
  233.  
  234. Example: (can you make up more examples than this? Gnort told me this one...)
  235. NEWS
  236.  
  237. If you don't like this speedwalk feature at all, then you can toggle it on/off
  238. with #speedwalk.
  239.  
  240. ===================================Ticker===================================
  241. Every 75 seconds on a standard dikumud a so called tick occures. You 
  242. regenerate faster hp/mana/mp if you`re sleeping/resting during a tick. So it's 
  243. pretty nice to know when the next tick occures. TINTIN helps you with that. 
  244. When you turn the ticker on in a session, you'll get warnings just before a 
  245. tick occures. The real ticklenght isn't 100% stable. So you have to set the 
  246. syncronize the ticker now and then. Use #tickset for that.
  247.  
  248. commands for ticker:
  249. #tickon              <=turns the ticker on in a session
  250. #tickoff             <=turns the ticker off in a session
  251. #tick                <=shows #seconds to next tick
  252. #tickset             <=reset the ticker
  253. #ticksize            <=set lenght of ticks. The ticklenght is not 75secs on
  254.                        some modified dikumuds.
  255.  
  256. Here's some useful aliases/actions related to the ticker:
  257.  
  258. #alias ? #tick
  259. #action "are hungry" "#tickset;say HA! my tickcounter is now perfectly set!"
  260.  
  261. NOTICE the #ticksay. #ticktell etc. commands from v2.0 has been removed. You
  262. can find an example of how to implement these commands with aliases in the
  263. coms file.
  264.  
  265. ===============================Commando files===============================
  266. When you order TINTIN to read a commandofile, TINTIN parse all the text in
  267. the file. You can use comandofiles to keep aliases/actions in, login to a 
  268. mud(name, password etc..) and basically all kinds of commands(unlike v2.0).
  269. You can make the commandofiles with either a texteditor, or use the 
  270. #writecoms commando to write out a file.
  271.  
  272. commands for files:
  273. #read filename            <=read and execute the file.
  274.  
  275. #write filename           <=write all actions/aliases/substitutes known for 
  276.                             current session to a file.
  277.  
  278. #writesession filename    <=write all actions/aliases/substitutes known for
  279.                             current session BUT not enherited to a file.
  280.  
  281. =============================Repeating commands============================
  282. You can repeat a command/commandline. The syntax is: #number command
  283.  
  284. examples:
  285. #5 cackle
  286. #10 "buy bread;put bread bag"        <=buy 10 breads and fill'em into a bag
  287. #1000 shout assholes!!!!!            <=noshout yourself.
  288.  
  289. ===================================History================================
  290. TINTIN has a limited subset of the csh history features. 
  291. #history          <=show the last 15 commands
  292. ! or !!           <=repeats the last command
  293. !5                <=execute 5. last command
  294. !cast             <=execute the last command in list starting with `cast`
  295.  
  296. =============================Path commands================================
  297. TINTIN tries to keep track of your movement. That is whenever you type
  298. either north/south/east/west/up/down, TINTIN will push the direction into
  299. a queue(the path). 
  300.  
  301. commands for path:
  302. #mark            <=mark beginning of path(ie reset queue)
  303. #path            <=show the path
  304. #return          <=go one step back in the path
  305. #unpath          <=forget last move in the path
  306. #action "Alas, you cannot go that way..." #unpath
  307.  
  308. real life example.. tatataaaa:
  309. You want a fast run to the master mindflayer and back. You go to dump
  310. and type: #mark. Then you run down and kill the master. To go back you
  311. just type: #30 #return
  312. You could ofcoz just as well have recalled outta there, but... Hell it's just
  313. an example.
  314.  
  315. ==============================Other commands===============================
  316. #boss                     <=fill screen with serious looking stuff
  317. #char new-char            <=change the tintin-char. The tintin-char is the 
  318.                             char infront of all tintin-commands.
  319. #help                     <= ...
  320. #nop                      <=for comments in coms-files
  321. #system unix-command      <=execute a unix-command
  322. #z                        <=cut link to current session. A faaaaast way out
  323.  
  324.